I urge Sysops to print this file out as a reference for when they set up UserGrabber. The data file (discussed below) has a lot of variables that need to be setup for proper operation of this application and its handy to have a "scratch copy" of this "Read Me" on hand to make notes. I have used a text data file because its a lot faster and easier to manage once it is set up. The overhead of a larger application taking more memory to have a built in setup dialog interface for variables that only need to be setup once didn't seem like a good idea to me. When upgrading from previous versions of UserGrabber, always read and print this file because some of the data fields change from time to time as I continue to improve this application. You can also read further in the documentation under the title of "Upgrading" for a quick reference of what you need to do to upgrade from the previous version of the application. Finally, UserGrabber is fast a typical Second Sight 4.0 Userlog with 300 users takes only 5 seconds to process on my Power Macintosh. You may want to read the System Requirements located at the end of this document.
What is it?:
UserGrabber is an application for Second Sight that analyzes your Userlog during a netmail or a nightly external launch of Second Sight and creates a nicely formatted top ten user activity report that you can use as a SYSTEMx.MSG or a readable text file for you and your users to enjoy with optional ANSI color output (see the below example for what the output looks like).
Why Use It?:
I have always felt that positive feedback is a good motivate of users. A top ten listing of your best users makes them feel like they have accomplished something on your BBS and that they are appreciated as a real contributor of your system. By creating a top ten list such as shown below, or as a separate text file command within a menu, that lets them know they are appreciated. I now have two users (you can see their names on my example) that battle each other for the top spot in the Upload category; the result - they have fun and I get plenty of new uploads to enhance my data libraries.
As you can see below, UserGrabber creates a second text file with the top downloaders and private message posters. You can use this as a Sysop report to see who is taking the most and giving very little in return; or since I consider myself an easy Sysop to get along with, I just let all the users see this report and make a note in the menu item its listed in that "Its all in good fun" anyway.
Also, as you can see below, UserGrabber creates a third text file with the top BBS callers and the total information in your current Userlog that each of the top ten fields generate. You can use this report to show your users who the top callers are and the total contributions by all of the users.
What The Output Files Look Like:
Above you can see the result of launching UserGrabber. Three nice ANSI outputs are presented (for those users who can support it) and for those who cannot, Second Sight’s excellent ANSI filter will remove the colors and the boarders for you.
How To Set It Up:
1. Place UserGrabber and the UserGrabberData file in the same folder as your Second Sight application, they must be in the same folder as the BBS program to operate correctly.
2. Using a text processor (SimpleText, RedWriter) open the UserGrabberData file, you will see something that looks like this:
255
Macintosh HD1:SSBBS:UserLog
Macintosh HD1:SSBBS:BBS System Files:SYSTEM3.MSG
Macintosh HD1:SSBBS:BBS System Files:SYSOP.MSG
Macintosh HD1:SSBBS:BBS System Files:CALLS.MSG
Macintosh HD1:SSBBS:Second Sight
[0;1;34;47mThe Final Nexus [0;30;47m
5
1
6
2
3
3
6
1
2
8
1
1
0
This file contains the variables and data that UserGrabber needs to operate, listed below are what each variable is; customize it to suit your needs.
255 -Users above this Clearance Level
will not be added to the lists.
Macintosh HD1:SSBBS:Userlog -Path to Your Userlog
Macintosh HD1:SSBBS:BBS System Files:SYSTEM3.MSG-Where to Save Top UL/Pub Msg Output
Macintosh HD1:SSBBS:BBS System Files:SYSOP.MSG -Where to Save Top DL/Pri Msg Output
Macintosh HD1:SSBBS:BBS System Files:CALLS.MSG -Where to Save Top Calls Msg Output
Macintosh HD1:SSBBS:Second Sight -App to Launch When Done
[0;1;34;47mThe Final Nexus [0;30;47m -Your BBS Name (ANSI Optional)
5 -Header/Time/Date Color
1 -ANSI Boarder Color
6 -Color of Header Titles
2 -Top Ten Public Message Stats Color
3 -Top Ten Upload Info Color
3 -Top Ten Private Message Data Color
6 -Top Ten Download Data Color
1 -Top Ten Callers Data Color
2 -Total Users Information Color
8 -ANSI Background Color
1 -1=Output file has a clear screen
0=Output file has no clear screen
1 -If you are using SS 3.0.x this must
be a 0; if using SS 4.0 this is a 1.
0 -Used for Registration. If you have
not registered, leave as a 0.
ANSI Color Table for Above Variables
1 = Black
2 = Red
3 = Green
4 = Yellow
5 = Blue
6 = Magenta
7 = Cyan
8 = White
When To Use It:
Since everyone’s BBS is different, it is hard to say when to use UserGrabber. If you are using a netmail application, then you might as well run UserGrabber at the same time as part of your nightly mail activities. If your BBS runs some sort of maintenance utility that resets the Userlog (purges the inactive users) on a nightly basis, then you would want to have UserGrabber in the launch chain after your Userlog is updated. If UserGrabber is not your only timed utility, make sure that the next utility that you want to launch is the one specified in the “App to Launch When Done” string in the data file.
Note From The Author:
Thank you for taking the time to look at this, I hope it is a fine addition to your Bulletin Board System. It has taken me hours and hours of work to get it just right, so if you like it please send me just $5 to the address below. I’ll then keep you and your BBS on my list so you are the first to get the next version and any updates I may have for you. Also you may send any bug reports to my contact information. Most importantly it keeps me writing external applications for Second Sight and ensures that any comments or suggestions you have for UserGrabber or any application ideas gets top priority with me.
Sincerely,
Steve Major
Contact Information:
Steven Major
P.O. Box 562
Champlain, NY 12919
The Final Nexus BBS: 518-561-3002
AOL: Steve Majo
Internet: stevemajo@aol.com
Version History:
1.0 - Initial Release.
1.0.1 - Added the third text file for the Top Callers and Total User Information. Added
the Stopwatch cursor instead of the Arrow cursor while UserGrabber does its
thing. Even though UserGrabber is very fast (a typical userlog takes about 5
seconds to process), I added better MultiFinder support anyway for Sysops who
have multiple nodes and need background events updated to any user connected.
1.0.2 - Added some more window strings to let the user know what is going on with
UserGrabber. Added Registration Code process that will let you turn off the
"splash-line ad for my BBS".
1.0.3 - UserGrabber now supports the new Second Sight 4.0 version. Due to Second
Sight now using a 1024 byte Userlog (instead of a 136 byte), there is an
additional data field to let the user choose a version of Second Sight for
correct processing of the Userlog.
1.0.4 - Fixed a problem in this Doc file that would not allow a Sysop to set up the
application correctly (I left out the info for the third file path above). Also I
I fixed an ANSI code error for the Splash Line for my BBS that was in error.
1.0.5 - Fixed the ANSI screen clear problem that caused the background color to be
black text on white when it should have been what the user selected in the
data files variable.
1.0.6 - Recompiled application for increased reliability and speed with System 7.5.x
and PowerPC Macs.
1.0.7 - Recompiled application for increased reliability and speed with System 7.5.3.
Fixed a bug that would cause UserGrabber to lose the custom icons and
lose high number values; both problems happened only in version 1.0.6.
What Next?:
I have no idea what will come exactly next. Version 4.0 of Second Sight is out now, and has some interesting features. Once I've played with it and know what exactly those features are, I can then better estimate what I'll write next. Oh, a word of warning about version 4.0! The UserLog Structure has changed for it! Although not a problem for UserGrabber you must be sure to specify the correct setting in the Data file for Userlog processing.
Register UserGrabber:
If you are using UserGrabber, please register it. As you can see above I have many plans for Second Sight but they will not come true without incentive. By registering CallGrabber, you will get a registration code that will enable you to turn off the splash-ad for my BBS in all three text files as well as the ANSI line above it.
Upgrading:
If you are upgrading from version 1.0.3, 1.0.4, 1.05 or 1.0.6 of UserGrabber, you need to do nothing, just replace your old application version with the new 1.0.7.
Distribution:
UserGrabber maybe freely uploaded to any Bulletin Board or On-Line service. Shareware vendors may include UserGrabber in any or all of their Shareware bundles, providing that I am notified by E-Mail or In Writing of the plans to include UserGrabber.
System Requirments:
UserGrabber will work with Second Sight 2.0 or above. System 7.x and 512K free RAM are required.
